home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3dm / audio / ALgetsampfmt.z / ALgetsampfmt
Encoding:
Text File  |  1998-10-20  |  6.2 KB  |  133 lines
  1.  
  2.  
  3.  
  4. AAAALLLLggggeeeettttssssaaaammmmppppffffmmmmtttt((((3333ddddmmmm))))                                            AAAALLLLggggeeeettttssssaaaammmmppppffffmmmmtttt((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ALgetsampfmt, ALsetsampfmt - (obsolete) get/set the sample format setting
  10.      in an audio AAAALLLLccccoooonnnnffffiiiigggg structure
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiioooo....hhhh>>>>
  14.  
  15.      lllloooonnnngggg AAAALLLLggggeeeettttssssaaaammmmppppffffmmmmtttt((((AAAALLLLccccoooonnnnffffiiiigggg ccccoooonnnnffffiiiigggg))))
  16.  
  17.      iiiinnnntttt AAAALLLLsssseeeettttssssaaaammmmppppffffmmmmtttt((((AAAALLLLccccoooonnnnffffiiiigggg ccccoooonnnnffffiiiigggg,,,, lllloooonnnngggg ssssaaaammmmpppplllleeeeffffoooorrrrmmmmaaaatttt))))
  18.  
  19. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  20.      _c_o_n_f_i_g         expects an AAAALLLLccccoooonnnnffffiiiigggg structure, the returned value of a
  21.                     call to AAAALLLLnnnneeeewwwwccccoooonnnnffffiiiigggg((((3333ddddmmmm)))) or AAAALLLLggggeeeettttccccoooonnnnffffiiiigggg((((3333ddddmmmm)))).
  22.  
  23.      _s_a_m_p_l_e_f_o_r_m_a_t   expects a symbolic constant that identifies the format of
  24.                     an audio sample.  There are three symbolic constants
  25.                     defined for this parameter.
  26.  
  27. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  28.      AAAALLLLsssseeeettttssssaaaammmmppppffffmmmmtttt and AAAALLLLggggeeeettttssssaaaammmmppppffffmmmmtttt are obsolete and are provided for backward
  29.      compatibility. The preferred functions are aaaallllSSSSeeeettttSSSSaaaammmmppppFFFFmmmmtttt((((3333ddddmmmm)))) and
  30.      aaaallllGGGGeeeettttSSSSaaaammmmppppFFFFmmmmtttt((((3333ddddmmmm)))).
  31.  
  32.      AAAALLLLsssseeeettttssssaaaammmmppppffffmmmmtttt((((3333ddddmmmm)))) sets the sample format in the AAAALLLLccccoooonnnnffffiiiigggg structure
  33.      _c_o_n_f_i_g.  Any audio port that you then configure using _c_o_n_f_i_g will have
  34.      the audio sample format you specify with _s_a_m_p_l_e_f_o_r_m_a_t.
  35.  
  36.      AAAALLLLggggeeeettttssssaaaammmmppppffffmmmmtttt((((3333ddddmmmm)))) returns the current sample format setting in the
  37.      AAAALLLLccccoooonnnnffffiiiigggg structure _c_o_n_f_i_g.
  38.  
  39.      The currently defined set of sample formats found in _a_u_d_i_o._h are:
  40.  
  41.           AL_SAMPFMT_TWOSCOMP
  42.                indicates linear PCM two's complement integer sample
  43.                format. Width of the integer data is one of signed char,
  44.                short, or long as specified by the AAAALLLLsssseeeettttwwwwiiiiddddtttthhhh((((3333ddddmmmm))))
  45.                function.
  46.           AL_SAMPFMT_FLOAT
  47.                indicates linear PCM IEEE 32-bit floating point
  48.                sample format.
  49.           AL_SAMPFMT_DOUBLE
  50.                indicates linear PCM IEEE 64-bit floating
  51.                point sample format.
  52.  
  53.           AAAALLLLsssseeeettttssssaaaammmmppppffffmmmmtttt((((3333ddddmmmm)))) can fail for the following reasons:
  54.  
  55.           AAAALLLL____BBBBAAAADDDD____CCCCOOOONNNNFFFFIIIIGGGG    _c_o_n_f_i_g is invalid or null.
  56.  
  57.           AAAALLLL____BBBBAAAADDDD____SSSSAAAAMMMMPPPPFFFFMMMMTTTT   _s_a_m_p_l_e_f_o_r_m_a_t is not one of the accepted constants.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. AAAALLLLggggeeeettttssssaaaammmmppppffffmmmmtttt((((3333ddddmmmm))))                                            AAAALLLLggggeeeettttssssaaaammmmppppffffmmmmtttt((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.           AAAALLLLggggeeeettttssssaaaammmmppppffffmmmmtttt((((3333ddddmmmm)))) can fail for the following reason:
  75.  
  76.           AAAALLLL____BBBBAAAADDDD____CCCCOOOONNNNFFFFIIIIGGGG   _c_o_n_f_i_g is invalid or null.
  77.  
  78. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  79.      Upon successful completion, AAAALLLLggggeeeettttssssaaaammmmppppffffmmmmtttt((((3333ddddmmmm)))) returns a long whose value
  80.      is the same as one of the symbolic constants described above for
  81.      _s_a_m_p_l_e_f_o_r_m_a_t. Otherwise, AAAALLLLggggeeeettttssssaaaammmmppppffffmmmmtttt((((3333ddddmmmm)))) returns -1 and sets an error
  82.      number which can be retrieved with oooosssseeeerrrrrrrroooorrrr((((3333CCCC)))).
  83.  
  84.      Upon successful completion, AAAALLLLsssseeeettttssssaaaammmmppppffffmmmmtttt((((3333ddddmmmm)))) returns 0. Otherwise, -1 is
  85.      returned and an error number is set as described above.
  86.  
  87.  
  88. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  89.      ALnewconfig(3dm), ALgetconfig(3dm), ALopenport(3dm), ALsetconfig(3dm),
  90.      ALsetfloatmax(3dm), ALgetfloatmax(3dm), oserror(3C)
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.